Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove generated examples, its unclear what it means. #3354

Merged
merged 1 commit into from
Mar 6, 2019

Conversation

brendandburns
Copy link
Contributor

As far as I can tell this qualification is poorly understood, and actually not a great goal anyway, since the generated examples (e.g. https://github.com/kubernetes-client/java/blob/master/kubernetes/docs/AppsV1Api.md#deleteCollectionNamespacedDaemonSet) aren't really that useful anyway.

There's separate requirements about docs for the stable status below, and this is confusing various people
(e.g. kubernetes-client/javascript#182)

Thus, I think it makes sense to delete this requirement.

cc @lavalamp @mbohlool

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/design Categorizes issue or PR as related to design. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. labels Mar 5, 2019
@k8s-ci-robot k8s-ci-robot requested review from deads2k and lavalamp March 5, 2019 00:22
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 5, 2019
@lavalamp
Copy link
Member

lavalamp commented Mar 5, 2019

@pwittrock

@brendandburns
Copy link
Contributor Author

Friendly ping on this :) I realize that most people don't have a strong opinion, but it would be good to get this merged or commented :)

@lavalamp
Copy link
Member

lavalamp commented Mar 6, 2019

AFAIK we never completely finished off generating good examples. I'm fine removing this for now since that's more accurate, with the understanding that if @pwittrock (or someone else) makes that work & easy, we will put it back.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 6, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, lavalamp

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit b9bb864 into kubernetes:master Mar 6, 2019
@brendandburns
Copy link
Contributor Author

@lavalamp thanks, definitely fine with the idea, just that it is more or less impossible to achieve in the current form. Happy to add it back in when the tools are better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/design Categorizes issue or PR as related to design. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants